feat(json): add reviver support to GET, MGET, and ARRPOP by JeanSamGirard · Pull Request #3205 · redis/node-redis

JeanSamGirard · 2026-03-25T19:00:40Z

Allows passing an optional JSON.parse reviver function to transformReply. This enables automatic rehydration of types (like Dates) that are not natively supported by JSON.

Modified:

JSON.GET: Added reviver to GetOptions
JSON.MGET: Added reviver to arguments
JSON.ARRPOP: Added reviver to ArrPopOptions
generic-transformers: Added reviver to transformRedisJsonReply and transformRedisJsonNullReply arguments

Utilized .preserve to pass reviver through commands.

Description

I need to store arbitrary data structures in redis that may contain date objects or class instances that need to be rehydrated after being stringified, I believe others may have this need.

Commands that return JSON already needed to go through JSON.parse so this looked like a logical and easy feature to implement with the existing code structure. This is why I went ahead with making a pull request to add this feature myself instead of just creating an issue. (No linked issues)

PS: This is my first time contributing so if I'm doing anything wrong please tell me, thank you.

Checklist

Does npm test pass with this change (including linting)?
Is the new or changed code fully tested?
Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?

Note

Low Risk
Backward-compatible optional API on read paths only; behavior unchanged when reviver is omitted.

Overview
Adds optional JSON.parse reviver support when decoding JSON command replies, so callers can rehydrate values (e.g. ISO date strings back to Date) after Redis returns plain JSON text.

Shared helpers transformRedisJsonReply / transformRedisJsonNullReply now take an optional JsonReviver and pass it into JSON.parse. JSON.GET, JSON.MGET, and JSON.ARRPOP expose reviver on options (or as a third argument for mGet); parseCommand stores it on parser.preserve, which the client already forwards into transformReply (including MULTI). ARRPOP options typing is tightened so path/index stay grouped with path. JSDoc and integration tests cover reviver behavior and multi().json.get.

^{Reviewed by Cursor Bugbot for commit 9b35e7f. Bugbot is set up for automated code reviews on this repo. Configure here.}

Allows passing an optional JSON.parse reviver function to transformReply. This enables automatic rehydration of types (like Dates) that are not natively supported by JSON. Modified: - JSON.GET: Added reviver to GetOptions - JSON.MGET: Added reviver to arguments - JSON.ARRPOP: Added reviver to ArrPopOptions - generic-transformers: Added reviver to transformRedisJsonReply and transformRedisJsonNullReply arguments Utilized .preserve to pass reviver through commands.

jit-ci · 2026-03-25T19:00:54Z

Hi, I’m Jit, a friendly security platform designed to help developers build secure applications from day zero with an MVS (Minimal viable security) mindset.

In case there are security findings, they will be communicated to you as a comment inside the PR.

Hope you’ll enjoy using Jit.

Questions? Comments? Want to learn more? Get in touch with us.

nkaradzhov · 2026-03-26T15:11:59Z

Hi @JeanSamGirard, thanks for the PR!

I’d like 2 changes before merge:

JSON.ARRPOP should not require path just to pass reviver.
Right now, passing { reviver } without path builds invalid
args.
Please add tests for the new behavior:

JSON.GET with reviver
JSON.MGET with reviver
JSON.ARRPOP with reviver
one multi/pipeline case to confirm preserve flows correctly
there too

After that, this looks good to merge.

P.S. Its generally a good idea to open an issue before any work is done. This way you will make sure the feature is aligned and accepted by the maintainers beforehand, otherwise you are risking investing the time to implement something that could be rejected later.

JeanSamGirard · 2026-03-26T17:46:52Z

Hi @JeanSamGirard, thanks for the PR!

I’d like 2 changes before merge:

JSON.ARRPOP should not require path just to pass reviver.
Right now, passing { reviver } without path builds invalid
args.

Please add tests for the new behavior:

JSON.GET with reviver

JSON.MGET with reviver

JSON.ARRPOP with reviver

one multi/pipeline case to confirm preserve flows correctly
there too

After that, this looks good to merge.

P.S. Its generally a good idea to open an issue before any work is done. This way you will make sure the feature is aligned and accepted by the maintainers beforehand, otherwise you are risking investing the time to implement something that could be rejected later.

Hi,

I made the fix for JSON.ARRPOP and added a test using a reviver for the 3 commands. (I'm not sure in which file the test for multi should go)

Unfortunately it seems I'm unable to run them on my local for some reason... I'm on Windows 11 with docker desktop I keep getting "before all" hook for "client.json.get" I think the client isn't able to connect to the container.

PS: Noted in the future I'll make an issue first ;)

PPS: Sorry for all the additional commits, couldn't test locally so I had to trust 😅

…array (using . instead)

…mGirard/node-redis into feat/json-reviver-support

JeanSamGirard · 2026-03-31T16:59:47Z

Hi @nkaradzhov, wasn't sure if I should ping in my previous message.

I ended up adding the multi() test case in packages\json\lib\commands\GET.spec.ts using multi().json.get for the test.

If there's no other changes needed could you please approve so the tests can run?
I would've run the test locally if I could, but I can't get it to work.

Thank you

…into feat/json-reviver-support

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{Reviewed by Cursor Bugbot for commit d8f9d88. Configure here.}

JeanSamGirard added 2 commits March 26, 2026 13:34

fix(json): ARRPOP path should be optional even if reviver is set

5e1d3d7

tests(json): add reviver tests

a1f862b

cursor Bot reviewed Mar 26, 2026

View reviewed changes

Comment thread packages/json/lib/commands/GET.spec.ts Outdated

Comment thread packages/json/lib/commands/ARRPOP.ts

Comment thread packages/json/lib/commands/ARRPOP.spec.ts

JeanSamGirard added 3 commits March 26, 2026 13:48

tests(json): typo in tests

9254d8a

tests(json): fix MGET test with reviver using $ but not expecting an …

ed7aa40

…array (using . instead)

fix(json): ARRPOP should ignore index if path is not defined

d26496f

cursor Bot reviewed Mar 26, 2026

View reviewed changes

Comment thread packages/json/lib/commands/ARRPOP.ts

JeanSamGirard added 2 commits March 26, 2026 14:08

fix(json): ARRPOP path option is optional

7d09619

tests(json): added test with multi() to json.GET

ebffff0

cursor Bot reviewed Mar 31, 2026

View reviewed changes

Comment thread packages/json/lib/commands/GET.spec.ts

JeanSamGirard added 2 commits March 31, 2026 12:21

tests(json): added test with multi() to json.GET

9cc42f8

Merge branch 'feat/json-reviver-support' of https://github.com/JeanSa…

5b39014

…mGirard/node-redis into feat/json-reviver-support

Merge branch 'master' of https://github.com/JeanSamGirard/node-redis …

d8f9d88

…into feat/json-reviver-support

cursor Bot reviewed May 25, 2026

View reviewed changes

Comment thread packages/json/lib/commands/ARRPOP.ts

JeanSamGirard added 3 commits May 25, 2026 13:58

fix(json): revert unintended change due to merging from older source

6885b6c

docs(json): js-doc for reviver option

cf2c568

fix(json): ARRPOP Optional path option

9b35e7f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(json): add reviver support to GET, MGET, and ARRPOP#3205

feat(json): add reviver support to GET, MGET, and ARRPOP#3205
JeanSamGirard wants to merge 14 commits into
redis:masterfrom
JeanSamGirard:feat/json-reviver-support

JeanSamGirard commented Mar 25, 2026 •

edited

Loading

Uh oh!

jit-ci Bot commented Mar 25, 2026

Uh oh!

nkaradzhov commented Mar 26, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JeanSamGirard commented Mar 26, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

JeanSamGirard commented Mar 31, 2026

Uh oh!

cursor Bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

JeanSamGirard commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

PS: This is my first time contributing so if I'm doing anything wrong please tell me, thank you.

Checklist

Uh oh!

jit-ci Bot commented Mar 25, 2026

Uh oh!

nkaradzhov commented Mar 26, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JeanSamGirard commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JeanSamGirard commented Mar 31, 2026

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

JeanSamGirard commented Mar 25, 2026 •

edited

Loading

JeanSamGirard commented Mar 26, 2026 •

edited

Loading